Copyright: Copyright 1997-98 Elevate Software


Contents

DBISAM Database System Utility

Shipping Release 1.05

The DBISAM Database System Utility is designed to provide the developer using DBISAM with a quick and easy way to update, search, restructure, and overall manage the data files involved in his/her Delphi projects.  This utility should prove to be more than adequate for replacing the functionality present in the Database Desktop provided with Delphi for use with BDE database projects.  Please make sure that you take a moment to go through the Before You Begin topic before using the Database System Utility.

 Before You Begin

 Configuring System Options

 Working with Data Files

 Performing Actions on Open Data Files

 Using the Utilities

Did we miss anything that you were looking for ?  If so, please let us know so that we can add it to the online help and get it out to other users.

Delphi, BDE, Database Desktop, dBase, and Paradox are trademarks of Inprise Corporation (formerly Borland International)

Windows, Windows 95, Windows NT, Microsoft Exhange, FoxPro and Access are trademarks of Microsoft Corporation

DBISAM is a trademark of Elevate Software


Before You Begin

There are a few items to consider before using the Database System Utility.  Please read through the following notes to make sure that the Database System Utility is easy to use and hassle-free.

Issue	Notes

Performing Actions on

Data Files	All options available on the Action sub-menu of the main menu and also the Print option on the File sub-menu are only available when a data file is open and always only apply to the current (top-most) data file opened.  The exception to this is the Print option, which allows you to print both structures and listings of all open data files.

Importing/Exporting Text Files

with Memo Fields	The Database System Utility will allow you to import memos into memo fields as long as the memo contents do not contain embedded CR/LF's.  Also, the Database System Utility will export memo contents from memo fields that contain CR/LF's but will strip them out in the exported text file.  Please keep this in mind and adjust your import and export techniques accordingly.

Importing/Exporting Text Files

with Non-Text Blob Fields	The Database System Utility also will allow you to import non-text (not memo fields) blob fields by placing the name of the file to import as a string into the blob field position in the imported text file.  This file name must include the complete path to the desired file.  If a file specified in the imported text file does not exist it will simply be ignored.  The Database System Utility will also write out non-text blob fields to separate files and place these file names as strings into any exported text file. Any graphic fields (bitmaps) will have the appropriate BMP extension added to the file name while non-graphic blob fields will have the generic extension of GBD (General Blob Data).  Please keep this in mind and adjust your import and export techniques accordingly.

Multiple Selections in

Data File Open and Save Dialogs	All of the dialogs in the Database System Utility used to open, select, save, or create data files allow for multiple selections.  To take advantage of this feature just simply hold down the CTRL key and click on the desired data file names in the dialog or hold down the SHIFT key and select the first and last data file names in a range of data file names that you wish to select.

Opening Data Files Exclusively	You should be very careful when opening up data files exclusively that are used in another shared application on a network.  Doing this may block out other applications from opening up the data file at all and may cause unnecessary confusion.  A better solution, if you need to make sure that no one else modifies the data file, is to open the data file in shared mode and then lock the entire data file so that others can open and read from the data file but not modify it.

Record Numbers	The record numbers displayed at the bottom of the Database System Utility when a data file is open will vary in behavior depending upon whether an active range, filter, or both, exists.  Record numbers in DBISAM are "logical" record numbers, meaning they differ for any given physical record depending upon the active index.

When a range is in effect the logical record numbers will start at the first record in the range and continue until the last record in the range is reached. For example, if a range is set that causes only 3000 records to be visible, then record number 100 will be the 100th record in the range according to the active index.

When a filter is in effect the logical records will still start at the first record in the data file and continue until the last record in the data file is reached.  However, if a record does not fall into the current filter then that record number will be "skipped" in the sequence of record numbers according to the active index.  For example, if a filter is set that causes records 100-103 to not be visible, then navigating past record number 99 will cause the record number to skip to the 104th record.

When a range and a filter are in effect the logical records will still start at the first record in the range and continue until the last record in the range is reached.  However, if a record does not fall into the current filter then that record number will be "skipped" in the sequence of record numbers according to the active index.  For example, if a range is set that causes only 200 records to be visible and a filter is set that causes records 100-103 to not be visible, then navigating past record number 99 will cause the record number to skip to the 104th record in the current range.

Record Counts	Record counts are always accurate, regardless of whether a range, filter, or both are active.  This can sometimes cause some confusing results because the record number when a filter is active is based on either the total records in the data file or the total records visible in the active range while the record count reflects the total number of records present in the active filter.  For example, if a filter is active (but no ranges are active) the record number may show 10005 and the record count may show 100.  What this means is that the current record is the 10005 record in the data file according to the active index and there are only 100 records currently visible due to the active filter.

Restructuring Data Files	Using the Restructure option of the Database System Utility will cause a backup of the data file being restructured to be created in all cases except when identifiers such as the data file description, field names, or index names are simply being renamed.  The backup file names have the same root as the original file name but with a different extension.  The following table lists the backup file extensions:

Component	Extension

Data Files

(xxxxxxxx.DAT)	The backup extension for data files is .DBK

Index Files

(xxxxxxxx.IDX)	The backup extension for index files is .IBK

Blob Files

(xxxxxxxx.BLB)	The backup extension for blob files is .BBK

All of these files can be restored by simply renaming them with the proper .DAT, .IDX, or .BLB extension.

Empyting, Copying, Renaming,

Deleting Data Files	All of these operations in the Database System Utility are irreversable, so please be extremely careful when using them.  The Database System Utility will prompt you to make sure that you want to execute the desired operation, and will allow you to cancel the operation if desired.  Still, it's very important that you use the utmost care in making sure that you have backups of your data files before executing any of these operations. Elevate Software cannot be held responsible for improper use of these operations.


Main Status Bar
This status panel will show the hints for menu items as you move the mouse over them and will also show the current state of the current open data file.


Main Open Mode
This status panel will show the current open mode of the current open data file.  The following list indicates the possible indicators for this status panel:

 The current data file is opened in shared mode and is read-only

 The current data file is opened in shared mode and is editable

 The current data file is opened in exclusive mode and is read-only

 The current data file is opened in exclusive mode and is editable


Main Index Key
This status panel will show the active index of the current open data file.


Main Filter
This status panel will show if a filter is currently active for the current open data file.  The following list indicates the possible indicators for this status panel:

 There is no filter active for the current data file

 There is a filter active for the current data file and it is completely non-optimizable (slowest)

 There is a filter active for the current data file and it is only partially optimizable (semi-fast)

 There is a filter active for the current data file and it is completely optimizable (fastest)


Main Range
This status panel will show if a range is currently active for the current open data file.  The following list indicates the possible indicators for this status panel:

 There is no range active for the current data file

 There is an active range for the current data file


Main Record Count
This status panel will show the record number and record count for the current open data file.


Main Lock
This status panel will show if the current record or the entire data file is locked for the current open data file.  The following list indicates the possible indicators for this status panel:

 The current record and the current data file are not locked

 The current record or the entire current data file are locked


About Program Icon
The program icon for the Database System Utility.


About Version Information
The version information for the Database System Utility.


About Close Button
Click on this button to close the About box.


Export File Name
Use this edit box to specify the name of the output text file to use for the exported data.


Export Select Button
Click on this button to select the output text file name from a standard Windows dialog.


Export Options
Use these radio buttons to select how you would like the exported data to be handled in the output text file. The two available options are to replace all records in the output text file or to append all records to the output text file. If the output text file doesn't exist then the two options are identical in their behavior.


Output File Type
Use these radio buttons to select the format of the output text file.  The two available options are comma-delimited or tab-delimited.


Output Foxpro Format
Use this check box to specify that the output text file should be in Microsoft FoxPro format.  Microsoft FoxPro uses a different format for Boolean and Date fields so if you plan on importing the output text file into Microsoft FoxPro you should make sure that this option is checked.


Export Button
Click on this button to begin the export process to the selected output text file.


Export Cancel Button
Click on this button to cancel the export process and close the export dialog.


Import File Name
Use this edit box to specify the name of the input text file to use for the imported data.


Import Select Button
Click on this button to select the input text file name from a standard Windows dialog.


Import Options
Use these radio buttons to select how you would like the imported data to be handled in the current data file. The three available options are to replace all records in the current data file, append all new records to the current data file and update any existing records, or only update any existing records. If the current data file doesn't contain any records then the first two options are identical in their behavior.  Please note that the primary index for the current data file is used to compare imported records from the input text file with the records in the current data file.


Input File Type
Use these radio buttons to select the format of the input text file.  The two available options are comma-delimited or tab-delimited.


Input Foxpro Format
Use this check box to specify that the input text file is in Microsoft FoxPro format.  Microsoft FoxPro uses a different format for Boolean and Date fields so if the input text file was exported from Microsoft FoxPro then you should make sure that this option is checked.


Import Button
Click on this button to begin the import process from the selected input text file.


Import Cancel Button
Click on this button to cancel the import process and close the import dialog.


Browse Tab
This page of the browse window shows the actual data contents in the current data file and the date and time of the last update. You can select which fields are visible using the Select Visible Fields button.


Browse Select Visible Fields Button
Click on this button to pull up a dialog that will let you select which fields are visible for the current data file.  Please note that all import and export operations only work on the visible fields, so you can use this option to control which fields are exported and which fields are available in an imported file.


Browse Last Update
This read-only information shows the date and time of the last update to the current data file.  You can update this information by clicking on the Refresh button on the main data navigator at the top of the main window.


Browse Grid
This grid shows the contents of the current data file.  You can edit or view any memo or graphic fields by simply double-clicking on the desired field in the desired record.  The fields that are visible in this grid are controlled by the Select Visible Fields button.


Browse Structure Tab
This page of the browse window shows the structure of the current data file.  You can find out detailed information regarding any field by selecting the desired field and clicking on the Details button.


Browse Secondary Indexes
This page of the browse window shows the secondary index of the current data file.  The primary index information for the current data file is shown on the Structure page of the browse window.


Browse Structure Description
This read-only information shows the description of the current data file.


Browse Structure Encrypted
This read-only information indicates whether the current data file is encrypted.


Browse Structure Password
This read-only information always shows "Password Not Shown" if the current data file is encrypted, or blank if the current data file is not encrypted.


Browse Structure Grid
This read-only grid shows the field structure information for the current data file.


Browse Structure Number Fields
This read-only information shows the number of fields defined in the current data file.


Browse Structure Total Record Size
This read-only information shows the total record size for the current data file.


Browse Structure Blob Block Size
This read-only information shows the BLOB block size for the current data file.


Browse Structure Details Button
Click on this button to open a dialog with detail information for the currently selected field in the fields grid.  The information that is shown in this dialog includes the field description, default value, minimum value, and maximum value.


Browse Primary Index Options
This read-only information shows what primary index options have been set for the current data file.  The two options available are descending and case-sensitive.


Browse Number Secondary Indexes
This read-only information shows the number of secondary indexes defined for the current data file.


Browse Secondary Indexes Grid
This read-only grid shows the secondary indexes defined  for the current data file.


Browse Field Description
This read-only information shows the description for the currently selected field.


Browse Default Value
This read-only information shows the default value for the currently selected field.


Browse Minimum Value
This read-only information shows the minimum value for the currently selected field.


Browse Maximum Value
This read-only information shows the maximum value for the currently selected field.


Browse Close Button
Click on this button to close the field details dialog and return to the browse window for the current data file.


Filter Available Fields
This listbox shows the available fields for filtering.  Any fields that can be optimized using an available index are indicated by an [Optimized] to the right of the field name.  To add a field to the filter expression simply double-click on the desired field name.


Filter Relational Operators
This listbox shows the available relational operatiors for filtering. To add a relational operator to the filter expression simply double-click on the desired relational operator.


Filter Logical Operators
This listbox shows the available logical operatiors for filtering. To add a logical operator to the filter expression simply double-click on the desired logical operator.


Filter Expression
This memo control is used to specify the filter expression to be used for filtering the current data file.  You have the option of selecting fields, relational operators, and logical operators from the list boxes provided or simply typing in the desired filter expression in this memo control. If the filter expression entered is not correct or contains a syntax error you will receive an appropriate message when attempting to set the filter by clicking on the Set button.


Filter Options
Use these check boxes to specify additional information about how the current filter expression should be processed.  If you do not want partial comparisons to be allowed by using the wildcard (*) character then you should click on the No Partial Comparions check box.  If you want any comparisons done on string fields to be case-insensitive then you should click on the Case-Insensitive check box.  Please note that changing the Case-Insensitive option can affect the optimizability of the current filter expression.  Only indexes that are marked as case-insensitive are available for use in optimizations in string field comparisons when you check the case-insensitive option.  Also note that only string field comparisons are affected by both the partial comparisons option and the case-insensitive option - all other field type comparisons ignore these options.


Filter Set Button
Click on this button to set the current filter expression and apply it to the current data file.  Depending upon the optimizability of the filter expression and the number of records in the current data file this process can range in execution time from instantaneous to several minutes.  Also, at this point you will be notified of any errors that are present in the filter expression and will be given the opportunity to correct them.


Filter Clear Button
Click on this button to clear the current filter expression and remove it from the current data file.


Filter Cancel Button
Click on this button to cancel setting or clearing the current filter expression and return to the current data file browse window.


Find Available Fields
This listbox shows the available fields for finding a record.  Any fields that can be optimized using an available index are indicated by an [Optimized] to the right of the field name.  To add a field to the find expression simply double-click on the desired field name.


Find Relational Operators
This listbox shows the available relational operatiors for finding a record. To add a relational operator to the find expression simply double-click on the desired relational operator.


Find Logical Operators
This listbox shows the available logical operatiors for finding a record. To add a logical operator to the find expression simply double-click on the desired logical operator.


Find Expression
This memo control is used to specify the find expression to be used for finding a record in the current data file.  You have the option of selecting fields, relational operators, and logical operators from the list boxes provided or simply typing in the desired find expression in this memo control. If the find expression entered is not correct or contains a syntax error you will receive an appropriate message when attempting to find a record by clicking on the First, Prior, Next, or Last buttons.


Find Options
Use these check boxes to specify additional information about how the current find expression should be processed.  If you do not want partial comparisons to be allowed by using the wildcard (*) character then you should click on the No Partial Comparions check box.  If you want any comparisons done on string fields to be case-insensitive then you should click on the Case-Insensitive check box.  Please note that changing the Case-Insensitive option can affect the optimizability of the current find expression.  Only indexes that are marked as case-insensitive are available for use in optimizations in string field comparisons when you check the case-insensitive option.  Also note that only string field comparisons are affected by both the partial comparisons option and the case-insensitive option - all other field type comparisons ignore these options.


Find First Button
Click on this button to find the first record in the current data file that matches the current find expression.  Depending upon the optimizability of the find expression and the number of records in the current data file this process can range in execution time from instantaneous to several minutes.  Also, at this point you will be notified of any errors that are present in the find expression and will be given the opportunity to correct them.  Please note that using this option will clear any active filter expression already set on the current data file.


Find Prior Button
Click on this button to find the prior record (based upon the current record position) in the current data file that matches the current find expression.  Depending upon the optimizability of the find expression and the number of records in the current data file this process can range in execution time from instantaneous to several minutes.  Also, at this point you will be notified of any errors that are present in the find expression and will be given the opportunity to correct them.  Please note that using this option will clear any active filter expression already set on the current data file.


Find Next Button
Click on this button to find the next record (based upon the current record position) in the current data file that matches the current find expression.  Depending upon the optimizability of the find expression and the number of records in the current data file this process can range in execution time from instantaneous to several minutes.  Also, at this point you will be notified of any errors that are present in the find expression and will be given the opportunity to correct them.  Please note that using this option will clear any active filter expression already set on the current data file.


Find Last Button
Click on this button to find the last record in the current data file that matches the current find expression.  Depending upon the optimizability of the find expression and the number of records in the current data file this process can range in execution time from instantaneous to several minutes.  Also, at this point you will be notified of any errors that are present in the find expression and will be given the opportunity to correct them.  Please note that using this option will clear any active filter expression already set on the current data file.


Find Cancel Button
Click on this button to cancel finding a record in the current data file and return to the current data file browse window.


Goto Record Number
Enter in the logical record number you wish to move to.  Please note that the logical record number is dependent upon any active ranges or filters.


Goto Record Go Button
Click on this button to move to the desired logical record number and return to the current data file browse window.  If the desired logical record number cannot be found then the record pointer will be positioned on the next closest logical record number.


Goto Record Cancel Button
Click on this button to cancel the logical record move and return to the current data file browse window.


Graphic Image
This control shows the graphic image (bitmap) for the current field in the current data file.  You can cut, copy, or paste this graphic image in order to change it or use the Import or Export buttons to read a new graphic image from a file or save the graphic image to a file.


Graphic Display Options
Use these check boxes to specify how the current graphic image should be displayed.  The Center Graphic option is used to center the graphic within the graphic control.  The Stretch Graphic option is used to stretch the graphic to fit the entire area of the graphic control.  Please note that the Stretch Graphic option has no effect upon icon (ICO) images. The Quick Draw option is used to indicate whether the graphic image is displayed using a palette. If not checked, a palette is used to provide the best possible image quality at the expense of additional processing time. If checked, no special palette is used, which is faster, but results in poorer picture quality, especially with 256-color images on a 256-color video driver.


Graphic Size Label
This read-only information indicates the size of the current graphic image in bytes.


Graphic Import Button
Click on this button to bring up a standard Windows file dialog that will allow you select a graphic file to import into the current field in the current data file.  You may import bitmap (BMP) images only.


Graphic Export Button
Click on this button to bring up a standard Windows file dialog that will allow you select a graphic file to export the current field into.


Graphic Close Button
Click on this button to close the current graphic dialog and return to the current data file browse window.


Memo Text
This control shows the memo text for the current field in the current data file.  You can cut, copy, or paste this text in order to change it or use the Import or Export buttons to read new text from a file or save the text to a file.


Memo Display Options
Use these check boxes to specify how the current memo text should be displayed.  The Want Tabs option is used to specify whether tabs can be entered into the current memo text within the memo control.  Please note that when this option is enabled you will not be able to use the TAB key to move out of the memo control.  The Word Wrap option is used to wrap lines of text when they extend beyond the right border of the memo control.


Memo Size Label
This read-only information indicates the size of the current memo text in bytes.


Memo Import Button
Click on this button to bring up a standard Windows file dialog that will allow you select a text file to import into the current field in the current data file.


Memo Export Button
Click on this button to bring up a standard Windows file dialog that will allow you select a text file to export the current field into.


Memo Close Button
Click on this button to close the current memo dialog and return to the current data file browse window.


Visible Available Fields
This listbox shows the available fields for the current data file that are currently not visible.  You may drag fields from this listbox and drop them in the Visible Fields listbox in order to make them visible.  You may also drag fields from the Visible Fields listbox and drop them in this listbox in order to make them non-visible, or drag and drop fields within this listbox to move them into different positions. This listbox fully supports multiple selection of fields by holding down the CTRL key and clicking on the desired fields or by holding down the SHIFT key and clicking on the first and last fields in the desired range of fields.


Visible Visible Fields
This listbox shows the visible fields for the current data file that are currently not visible.  You may drag fields from this listbox and drop them in the Available Fields listbox in order to make them non-visible.  You may also drag fields from the Available Fields listbox and drop them in this listbox in order to make them visible, or drag and drop fields within this listbox to move them into different positions.  This listbox fully supports multiple selection of fields by holding down the CTRL key and clicking on the desired fields or by holding down the SHIFT key and clicking on the first and last fields in the desired range of fields.


Visible Move One Button
Click on this button to move the currently selected fields in the Available Fields listbox into the Visible Fields listbox.


Visible Move All Button
Click on this button to move all of the fields in the Available Fields listbox into the Visible Fields listbox regardless of what fields are selected in the Available Fields listbox.


Visible Remove One Button
Click on this button to move the currently selected fields in the Visible Fields listbox into the Available Fields listbox.


Visible Remove All Button
Click on this button to move all of the fields in the Visible Fields listbox into the Available Fields listbox regardless of what fields are selected in the Visible Fields listbox.


Visible OK Button
Click on this button to make the visible field selections in this dialog active for the current data file and return to the current data file browse window.


Visible Cancel Button
Click on this button to cancel the visible field selection and return to the current data file browse window.


Index Available Fields
This listbox shows the available fields for the current data file that are currently not part of the secondary index being defined.  You may drag fields from this listbox and drop them in the Index Fields listbox in order to make them part of the secondary index.  You may also drag fields from the Index Fields listbox and drop them in this listbox in order to remove them from the secondary index, or drag and drop fields within this listbox to move them into different positions. This listbox fully supports multiple selection of fields by holding down the CTRL key and clicking on the desired fields or by holding down the SHIFT key and clicking on the first and last fields in the desired range of fields.


Index Index Fields
This listbox shows the index fields for the current data file that are currently part of the secondary index being defined.  You may drag fields from this listbox and drop them in the Available Fields listbox in order to remove them from the secondary index.  You may also drag fields from the Available Fields listbox and drop them in this listbox in order to make them part of the secondary index, or drag and drop fields within this listbox to move them into different positions within the secondary index.  This listbox fully supports multiple selection of fields by holding down the CTRL key and clicking on the desired fields or by holding down the SHIFT key and clicking on the first and last fields in the desired range of fields.


Index Move One Button
Click on this button to move the currently selected fields in the Available Fields listbox into the Index Fields listbox.


Index Move All Button
Click on this button to move all of the fields in the Available Fields listbox into the Index Fields listbox regardless of what fields are selected in the Available Fields listbox.


Index Remove One Button
Click on this button to move the currently selected fields in the Index Fields listbox into the Available Fields listbox.


Index Remove All Button
Click on this button to move all of the fields in the Index Fields listbox into the Available Fields listbox regardless of what fields are selected in the Index Fields listbox.


Index OK Button
Click on this button to make the secondary index field selections in this dialog active for the current secondary index being defined and return to the secondary index keys page of the structure dialog.


Index Cancel Button
Click on this button to cancel the secondary index field selection and return to the secondary index keys page of the structure dialog.


Options Working Folder
Use this edit box to specify the working folder for the Database System Utility.  The working folder is used as the default folder when opening, creating, renaming, copying, deleting, or emptying data files.


Options Select Button
Click on this button to open up a standard Windows folder selection dialog and select the working folder for the Database System Utility.  The working folder is used as the default folder when opening, creating, renaming, copying, deleting, or emptying data files.


Options Lock Retry Count
Use this edit box to enter the default lock retry count used for all data file operations within the Database System Utility.  The lock retry count may be any value from 0 to 255.  A higher setting allows for more lock retries before the user is notified of a lock failure.


Options Transactions In Memory
This check box is used to specify whether all transactions for data files within the Database System Utility will be logged in memory.  If this option is not checked then all transactions for data files will be logged in temporary disk files in the same directory as the data file being logged.  Transactions in DBISAM are logged on a per-data-file basis.


Options Maintain Passwords Button
Click on this button to open up the standard password maintenance dialog and add and remove passwords for the current Database System Utility session.  All passwords are stored in memory and are only available for the current session.  Exiting the Database System Utility will remove all previously-entered passwords.


Options OK Button
Click on this button to save the current options (everything except for the current passwords which are saved in memory) to the Windows system registry and return to the main window of the Database System Utility.


Options Cancel Button
Click on this button to cancel any changes made to the options and return to the main window of the Database System Utility.


Print Output Type
Use these radio buttons to select what you would like to print for the current data file.  You may print the structure of the current data file or a listing of the contents of the current data file.  The listing option is affected by the visible fields selection for the current data file as well as any ranges or filters that may be active on the current data file.  Please be careful when using the listing option with large data files since an extremely large number of pages in the printed listing may result.


Print Option
Use these radio buttons to select whether you want to print a structure or listing for the current (topmost) data file only or for all open data files.


Print Print Button
Click on this button to begin printing using the selected output type and options and return to the current data file browse window.


Print Setup Button
Click on this button to open the standard Windows printer setup dialog and change the printer settings.


Print Cancel Button
Click on this button to cancel printing and return to the current data file browse window.


Range Begin Key Values
Use this grid to enter the beginning key field values of the range. Only the fields that are part of the current active index will be shown in this grid.  You may choose to enter only part or none of the key field values.


Range End Key Values
Use this grid to enter the ending key field values of the range. Only the fields that are part of the current active index will be shown in this grid.  You may choose to enter only part or none of the key field values.


Range Set Button
Click on this button to set the current range and apply it to the current data file.  This process is always instantaneous and you will be notified if any of the key field values entered are invalid for the associated field.


Range Clear Button
Click on this button to clear the current range and remove it from the current data file.


Range Cancel Button
Click on this button to cancel setting or clearing the current range and return to the current data file browse window.


Reverse Folder
Use this edit box to specify the folder name to use as the DatabaseName property in the generated code for each TDBISAMTable component.


Reverse Select Button
Click on this button to open up a standard Windows folder selection dialog and select the folder to be used as the DatabaseName property in the generated code for each TDBISAMTable component.


Reverse Continue Button
Click on this button to continue with the reverse engineering process for the selected data file(s).


Reverse Cancel Button
Click on this button to cancel the reverse engineering process and return to the main window of the Database System Utility.


Search Options
Use this check box to specify whether the record pointer should be positioned on the next closest match if the currently entered key field values are not found in the current data file.


Search Key Field Values
Use this grid to enter the key field values for the range. Only the fields that are part of the current active index will be shown in this grid.  You may choose to enter only part or none of the key field values.


Search Search Button
Click on this button to search in the current data file for the entered key field values and return to the current data file browse window.  A message will be displayed if the entered key field values cannot be found in the current data file.


Search Cancel Button
Click on this button to cancel the search and return to the current data file browse window.


Index Available Indexes
This listbox will show the available indexes for the current data file.  You may click on any available index to select it and display the details about the index in the Index Details group box.  You may also double-click on any available index to immediately make it the active index and return to the current data file browse window.  Please note that changing the active index will remove any ranges that are active on the current data file and will re-order the contents of the current data file browse window according to the new active index.


Index Index Details
This read-only information shows the fields present in the current selected index in the available indexes list box as well as whether the selected index is descending, case-insensitive, or unique.


Index Select Button
Click on this button to make the currently selected index the active index and return to the current data file browse window.  Please note that changing the active index will remove any ranges that are active on the current data file and will re-order the contents of the current data file browse window according to the new active index.


Index Index Cancel Button
Click on this button to cancel changing the active index and return to the current data file browse window.


Structure Description
Use this edit box to enter the description of the current data file.


Structure Encrypted
Use this check box to specify whether the current data file is encrypted.  The password edit box is only accessible when the Encrypted check box is checked.


Structure Password
Use this edit box to enter the password for the current encrypted data file. The password edit box is only accessible when the Encrypted check box is checked, and if a data file is encrypted then a password must be entered.  The password can be any combination of between 1 and 15 characters and is case-sensitive.


Structure Number Fields
This read-only information shows the number of fields defined in the current data file.


Structure Total Record Size
This read-only information shows the total record size for the current data file.


Structure Blob Block Size
Use this edit box to specify the BLOB block size for the current data file.  The BLOB block size can be any size between 64 bytes and 64k bytes.


Structure Details Button
Click on this button to open a dialog with detail information for the currently selected field in the fields grid.  The information that is shown in this dialog includes the field description, default value, minimum value, and maximum value.  You may use this dialog to add and edit information regarding the currently selected field.


Structure Primary Index Options
Use these two check boxes to specify information about the primary index of the current data file.  The two options available are descending and case-sensitive.  All primary indexes are, by their nature, unique so this option is not available for primary indexes.


Structure Fields Grid
This grid shows the field structure information for the current data file.  You may use the UP and DOWN arrow keys to move from field to field.  If you move past the last defined field in the grid you will be allowed to add a new field at the end.  You may also insert a new field anywhere by pressing the INSERT key.  To delete an existing field hold down the CTRL key and press the DELETE key.  You will be asked to confirm the field deletion before the field is actually removed.  The left-hand side of the grid shows the field number for any given field.  You may use this area to drag and drop fields into any position that is needed.  The Field Type, Required, and Primary Index columns can only be changed by either pressing the SPACE BAR key or double-clicking on the desired value with the mouse.  In addition, the Field Type column may also be changed by pressing the first letter of the desired field type.  For example, if you hit the letter M it would bring up the first field type that begins with the letter M - a memo field.


Structure Save Button
Click on this button to save the structure information for the current data file.  If the data file is being created then you will be prompted to provide a data file name.  If the data file is being restructured, then a progress dialog will appear indicating the progress of the restructure.  If there are any data loss problems due to the restructuring you will be prompted with the appropriate message and the chance to ignore the problems or cancel the restructure process.  After the data file is created or restructured you will be returned to the main window of the Database System Utility.


Structure Cancel Button
Click on this button to cancel the data file creation (if a new data file was being created) or restructure process (if an existing data file was being restructured) and return to the main window of the Database System Utility.


Structure Field Description
Use this edit box to enter a description for the current field.  The description can be any combination of characters between 0 and 50 characters in length.


Structure Field Default Value
Use this edit box to enter a default value for the current field.  The default value can be any valid expression for the current field type including the special Now, Date, and Time constants for Date, Time, and Timestamp fields as well as True and False for Boolean fields.  Please note that you should not enter either single or double-quotes around string expressions.


Structure Field Minimum Value
Use this edit box to enter a minimum value for the current field.  The minimum value can be any valid expression for the current field type.  Please note that you should not enter either single or double-quotes around string expressions.


Structure Field Maximum Value
Use this edit box to enter a maximum value for the current field.  The maximum value can be any valid expression for the current field type.  Please note that you should not enter either single or double-quotes around string expressions.


Structure Field OK Button
Click on this button to save the detail information for the current field and return to the Structure dialog for the current data file.  If there are any errors in the default value, minimum value, or maximum value expressions you will be notified of them at this point and given a chance to correct them.


Structure Field Cancel Button
Click on this button to cancel the editing of the detail information for the current field and return to the Structure dialog for the current data file.  Any changes made to the detail information for the current field will be lost.


Structure Number Indexes
This read-only information shows the number of secondary indexes defined for the current data file.


Structure Secondary Indexes Grid
This grid shows the secondary index information for the current data file.  You may use the UP and DOWN arrow keys to move from index to index.  If you move past the last defined index in the grid you will be allowed to add a new index at the end.  You may also insert a new index anywhere by pressing the INSERT key.  To delete an existing secondary index hold down the CTRL key and press the DELETE key.  You will be asked to confirm the secondary index deletion before the secondary index is actually removed.  The Descending, Case-Insensitive, and Unique columns can only be changed by either pressing the SPACE BAR key or double-clicking on the desired value with the mouse.  The Index Fields column can be changed by selecting the desired secondary index and clicking on the Details button.


Structure Secondary Index Details Button
Click on this button to open up the Index Fields dialog for the selected secondary index.  This dialog will allow you select what fields should make up the selected secondary index.


Configuring System Options

To configure the system options for the Database System Utility please complete the following steps:

1	Select the File option from the main menu

2	Select the Options... option from the File menu

3	This will bring forward the Options dialog

Once the Options dialog is visible you may right-click on any control to receive help on that particular area of interest.


Working with Data Files

The basics of working with data files involve opening, closing, and creating new data files.  Please select from the following topics for more information on these areas.

 Creating a New Data File

 Opening an Existing Data File

 Closing an Open Data File


Creating a New Data File

To create a new data file in the Database System Utility please complete the following steps:

1    Select the File option from the main menu

2	Select the New... option from the File menu

3	This will bring forward the New Data File dialog

Once the New Data File dialog is visible you may right-click on any control to receive help on that particular area of interest.


Opening an Existing Data File

To open an existing data file in the Database System Utility please complete the following steps:

1    Select the File option from the main menu

2	If you wish to open a data file in Exclusive mode (all other users will be denied access to the data file) then you should select the Open Exclusive... option from the File menu.  If you wish to open a data file in Shared mode (all other users will be allowed to open the data file also) then you should select the Open Shared... option from the File menu.

3	This will bring forward a standard Windows file dialog that will allow you to select the desired data file to open and will also let you specify whether the file should be opened for editing or read-only.  At this point you may click on the OK button to open the data file or click on the Cancel button to cancel opening up a data file.

4	After you have selected the desired data file to open and clicked on OK in the file dialog you will see the desired data file open in a browse window in the Database System Utility.  If the data file is encrypted you will first be prompted for the password to the data file before being allowed to view or edit it's contents.  If you do not provide the correct password you will be denied access to the data file.


Closing an Open Data File

To close an open data file in the Database System Utility please complete the following steps:

1    Select the File option from the main menu

2	Select the Close... option from the File menu

3	This will close the current (topmost) data file browse window and it's associated data file.


Performing Actions on Open Data Files

There are many different actions that may be performed on any open data file.  Please select from the following topics for more information on these actions.

 Importing Text Files

 Exporting Text Files

 Locking an Entire Data File

 Unlocking an Entire Data File

 Starting a Transaction

 Committing a Transaction

 Rolling Back a Transaction

 Changing the Active Index Order

 Searching for a Record Using the Active Index Order

 Finding a Record Using an Expression

 Moving to a Specific Logical Record Number

 Setting a Range Using the Active Index Order

 Setting an Expression Filter

 Flushing the Buffers in a Data File Opened in Exclusive Mode


Importing Text Files

To import a text file into an open data file in the Database System Utility please complete the following steps:

1    Select the Action option from the main menu

2	Select the Import... option from the Action menu

3	This will bring forward the Import dialog

Once the Import dialog is visible you may right-click on any control to receive help on that particular area of interest.

Note

 	The visible fields in the current open data file browse window control which fields are looked at when importing text files.  Please make sure that the visible fields match the incoming fields in the text file being imported. Also, the current data file will be locked by default during the import process so that no other users can add, modify, or delete any records.


Exporting Text Files

To export a text file from an open data file in the Database System Utility please complete the following steps:

1    Select the Action option from the main menu

2	Select the Export... option from the Action menu

3	This will bring forward the Export dialog

Once the Export dialog is visible you may right-click on any control to receive help on that particular area of interest.

Note

 	The visible fields in the current open data file browse window control which fields are looked at when exporting text files.  Please make sure that the visible fields match the fields you need to have in the exported text file.


Locking an Entire Data File

To lock an entire open data file in the Database System Utility please complete the following steps:

1    Select the Action option from the main menu

2	Select the Lock Entire File... option from the Action menu

Note

 	No other users can modify the current data file when the entire data file is locked.  Also, locking the entire data file when the data file is opened exclusive does nothing since no other users have access to the data file anyways.


Unlocking an Entire Data File

To unlock an entire open data file in the Database System Utility please complete the following steps:

1    Select the Action option from the main menu

2	Select the Unlock Entire File... option from the Action menu


Starting a Transaction

To start a transaction on an open data file in the Database System Utility please complete the following steps:

1    Select the Action option from the main menu

2	Select the Start Transaction... option from the Action menu

Note

 	Any records involved in the current transaction will be locked until the transaction is committed or rolled back.  This means that no other users can modify these records.  Please keep this in mind and try to keep transaction duration times to a minimum.  Also, you should make sure that the Transactions In Memory option in the system options dialog is not checked if you plan on adding, modifying, or deleting a large number of records within the transaction.  If you do not then it's possible that the database system will run out of memory trying to log all of the changes in memory.


Rolling Back a Transaction

To rollback a transaction on an open data file in the Database System Utility please complete the following steps:

1    Select the Action option from the main menu

2	Select the Rollback Transaction... option from the Action menu

Note

 	Depending upon the number of records added, modified, or deleted in the transaction the rollback process make take a while to complete.  Please be patient and do not mistake this lapse in activity to be due to a lockup in the Database System Utility.


Committing a Transaction

To commit a transaction on an open data file in the Database System Utility please complete the following steps:

1    Select the Action option from the main menu

2	Select the Commit Transaction... option from the Action menu

Note

 	Depending upon the number of records added, modified, or deleted in the transaction the commit process make take a while to complete.  Please be patient and do not mistake this lapse in activity to be due to a lockup in the Database System Utility.


Changing the Active Index Order

To change the active index order on an open data file in the Database System Utility please complete the following steps:

1    Select the Action option from the main menu

2	Select the Select Index Order... option from the Action menu

3	This will bring forward the Select Index Order dialog

Once the Select Index Order dialog is visible you may right-click on any control to receive help on that particular area of interest.

Note

 	Changing the active index order will remove any ranges that are active on the current data file.  Also, since the logical record numbers are based upon the active index order the record number may also change.


Searching for a Record Using the Active Index Order

To search for a record using the active index order on an open data file in the Database System Utility please complete the following steps:

1    Select the Action option from the main menu

2	Select the Search for Record... option from the Action menu

3	This will bring forward the Search For Record dialog

Once the Search For Record dialog is visible you may right-click on any control to receive help on that particular area of interest.


Finding a Record Using an Expression

To find a record using an expression on an open data file in the Database System Utility please complete the following steps:

1    Select the Action option from the main menu

2	Select the Find a Record... option from the Action menu

3	This will bring forward the Find a Record dialog

Once the Find a Record dialog is visible you may right-click on any control to receive help on that particular area of interest.

Note

 	Using this option will clear any active filters that have been set for the current open data file.


Moving to a Specific Logical Record Number

To move to a specific logical record number in an open data file in the Database System Utility please complete the following steps:

1    Select the Action option from the main menu

2	Select the Go to Record... option from the Action menu

3	This will bring forward the Go to Record dialog

Once the Go to Record dialog is visible you may right-click on any control to receive help on that particular area of interest.

Note

 	If the specified logical record number is not found then the record pointer will be positioned on the next closest logical record number.


Setting a Range Using the Active Index Order

To set a range using the active index order on an open data file in the Database System Utility please complete the following steps:

1    Select the Action option from the main menu

2	Select the Set a Range... option from the Action menu

3	This will bring forward the Set a Range dialog

Once the Set a Range dialog is visible you may right-click on any control to receive help on that particular area of interest.


Setting an Expression Filter

To set an expression filter on an open data file in the Database System Utility please complete the following steps:

1    Select the Action option from the main menu

2	Select the Set an Expression Filter... option from the Action menu

3	This will bring forward the Set a Filter dialog

Once the Set a Filter dialog is visible you may right-click on any control to receive help on that particular area of interest.


Flushing the Buffers in a Data File Opened in Exclusive Mode

To flush the buffers in a data file opened in exclusive mode in the Database System Utility please complete the following steps:

1    Select the Action option from the main menu

2	Select the Flush Buffers... option from the Action menu

Note

 	This options is only enabled when the current open data file has been opened in exclusive mode.


Using the Utilities

There are several utilties available for performing special operations on data files.  Please select from the following topics for more information on these utilities.

 Restructuring Data Files

 Repairing Corrupted Data Files

 Emptying Data Files

 Copying Data Files

 Renaming Data Files

 Deleting Data Files

 Reverse-Engineering Data Files


Restructuring Data Files

To restructure a data file in the Database System Utility please complete the following steps:

1    Select the Utilities option from the main menu

2	Select the Restructure... option from the Utilties menu

3	This will bring forward a standard Windows file dialog that will allow you to select the desired data file to restructure.  At this point you may click on the OK button to restructure the data file or click on the Cancel button to cancel restructuring a data file.

4	After you have selected the desired data file to restructure and clicked on OK in the file dialog you will see the desired data file structure in a Modify Structure dialog.  If the data file is encrypted you will first be prompted for the password to the data file before being allowed to change it's structure.  If you do not provide the correct password you will be denied access to the data file.

Once the Modify Structure dialog is visible you may right-click on any control to receive help on that particular area of interest.


Repairing Corrupted Data Files

To repair a corrupted data file in the Database System Utility please complete the following steps:

1    Select the Utilities option from the main menu

2	Select the Repair... option from the Utilties menu

3	This will bring forward a standard Windows file dialog that will allow you to select the desired data file(s) to repair.  You may select multiple data files for repairing by holding down the CTRL key and clicking with the mouse on the data files you wish to repair or by holding down the SHIFT key and clicking on the start and end range of data files you wish to repair.  At this point you may click on the OK button to repair the selected data file(s) or click on the Cancel button to cancel repairing any data files.

4	After you have selected the desired data file(s) to repair and clicked on OK in the file dialog you will see a progress dialog open that shows the progress of the repair operation on the selected data file(s).

Once the repair operation is complete you will be notified of the success or failure of the operation.


Emptying Data Files

To empty a data file in the Database System Utility please complete the following steps:

1    Select the Utilities option from the main menu

2	Select the Empty... option from the Utilties menu

3	This will bring forward a standard Windows file dialog that will allow you to select the desired data file(s) to empty.  You may select multiple data files for emptying by holding down the CTRL key and clicking with the mouse on the data files you wish to empty or by holding down the SHIFT key and clicking on the start and end range of data files you wish to empty.  At this point you may click on the OK button to empty the selected data file(s) or click on the Cancel button to cancel emptying any data files.

4	After you have selected the desired data file(s) to empty and clicked on OK in the file dialog you will be asked to confirm that you wish to empty the selected data file(s).  You must click on the Yes button to complete the operation or the No button to cancel emptying any data files.

Once the empty operation is complete you will be notified of the success or failure of the operation.


Copying Data Files

To copy a data file in the Database System Utility please complete the following steps:

1    Select the Utilities option from the main menu

2	Select the Copy... option from the Utilties menu

3	This will bring forward a standard Windows file dialog that will allow you to select the desired data file(s) to copy.  You may select multiple data files for copying by holding down the CTRL key and clicking with the mouse on the data files you wish to copy or by holding down the SHIFT key and clicking on the start and end range of data files you wish to copy.  At this point you may click on the OK button to copy the selected data file(s) or click on the Cancel button to cancel copying any data files.

4	After you have selected the desired data file(s) to copy and clicked on OK in the file dialog you will be asked to specify the destination data file name for each selected data file(s).  You must select the destination file from the standard Windows file dialog for each data file name and click on the OK button to complete the operation.

Once the copy operation is complete you will be notified of the success or failure of the operation.


Renaming Data Files

To rename a data file in the Database System Utility please complete the following steps:

1    Select the Utilities option from the main menu

2	Select the Rename... option from the Utilties menu

3	This will bring forward a standard Windows file dialog that will allow you to select the desired data file(s) to rename.  You may select multiple data files for renaming by holding down the CTRL key and clicking with the mouse on the data files you wish to rename or by holding down the SHIFT key and clicking on the start and end range of data files you wish to rename.  At this point you may click on the OK button to renam the selected data file(s) or click on the Cancel button to cancel renaming any data files.

4	After you have selected the desired data file(s) to rename and clicked on OK in the file dialog you will be asked to specify the destination data file name for each selected data file(s).  You must select the destination file from the standard Windows file dialog for each data file name and click on the OK button to complete the operation.

Once the rename operation is complete you will be notified of the success or failure of the operation.


Deleting Data Files

To delete a data file in the Database System Utility please complete the following steps:

1    Select the Utilities option from the main menu

2	Select the Delete... option from the Utilties menu

3	This will bring forward a standard Windows file dialog that will allow you to select the desired data file(s) to delete.  You may select multiple data files for deleting by holding down the CTRL key and clicking with the mouse on the data files you wish to delete or by holding down the SHIFT key and clicking on the start and end range of data files you wish to delete.  At this point you may click on the OK button to delete the selected data file(s) or click on the Cancel button to cancel deleting any data files.

4	After you have selected the desired data file(s) to delete and clicked on OK in the file dialog you will be asked to confirm that you wish to delete the selected data file(s).  You must click on the Yes button to complete the operation or the No button to cancel deleting any data files.

Once the delete operation is complete you will be notified of the success or failure of the operation.


Reverse Engineering Data Files

To reverse engineer a data file in the Database System Utility please complete the following steps:

1    Select the Utilities option from the main menu

2	Select the Reverse Engineer... option from the Utilties menu

3	This will bring forward the Reverse Engineer options dialog where you can specify any options for the reverse engineer operation.  You may right-click on any control to receive help on that particular area of interest.  After you have specified the reverse engineer options you may click on the Continue button to continue with the reverse engineer operation or you may click on the Cancel button to cancel the reverse engineer operation.

3	This will bring forward a standard Windows file dialog that will allow you to select the desired data file(s) to reverse engineer.  You may select multiple data files for reverse engineering by holding down the CTRL key and clicking with the mouse on the data files you wish to reverse engineer or by holding down the SHIFT key and clicking on the start and end range of data files you wish to reverse engineer.  At this point you may click on the OK button to continue or click on the Cancel button to cancel reverse engineering any data files.

4	After you have selected the desired data file(s) to reverse engineer and clicked on OK in the file dialog you will be prompted with another standard Windows file dialog that will allow you to specify the name of the .PAS (Delphi source file) to use for generating the table creation code for the selected data file(s).  At this point you may click on the OK button to reverse engineer the selected data file(s) into the specified source file or click on the Cancel button to cancel reverse engineering any data files.

Once the reverse engineer operation is complete you will be notified of the success or failure of the operation.


Options Lock Wait Time
Use this edit box to enter the default lock wait time used for all data file operations within the Database System Utility.  The lock wait time may be any value from 0 to 65536.  A higher setting allows for more time between lock retries.